home *** CD-ROM | disk | FTP | other *** search
/ EuroCD 3 / EuroCD 3.iso / Programming / vbcc / machines / amiga68k / doc / vbrowse.doc < prev    next >
Encoding:
Text File  |  1998-06-24  |  3.4 KB  |  111 lines
  1. vbrowse by Volker Barthelmann
  2.  
  3. INTRODUCTION
  4.  
  5.     vbrowse is used as a message browser for vbcc. In conjunction with
  6.     vsend, tovbr and showerr it can display messages of vbcc in a window
  7.     with a listview gadget, start an editor and place the cursor on
  8.     the source line that caused the error/warning or give a more detailed
  9.     explanation of the error.
  10.     With a configurable editor it should be possible to create a kind
  11.     of simple integrated development environment.
  12.  
  13.     vbrowse needs gadtools.library V39 or higher.
  14.  
  15.  
  16. LEGAL
  17.  
  18.     vbrowse, vsend, tovbr and showerr are public domain.
  19.  
  20.  
  21. USAGE
  22.  
  23.     When run vbrowse opens a window with a listview gadget and creates
  24.     a public message port. It will display all strings sent to it (by
  25.     vsend usually) in the listview.
  26.     If you double-click on a line that looks like a vbcc message it
  27.     will invoke a configurable command.
  28.  
  29.     In error messages vbcc quotes one line of the file where the problem
  30.     was encountered and displays one line that explains the error and
  31.     contains filename and line number.
  32.  
  33.     If you double-click on the quoted line one command will be invoked
  34.     with the filename and the line number as arguments. This command
  35.     should load the file into an editor and place the cursor on the
  36.     correct line.
  37.     It can be configured by specifying 'editor string' at the
  38.     command line where 'string' is the command to be executed. %d
  39.     will be replaced by the line number and %s by the filename. But
  40.     note that %d MUST be first, e.g.
  41.  
  42.         run vbrowse editor "rx my_arexx_script %d %s" or
  43.         run vbrowse editor "ged line %d %s"
  44.  
  45.     is ok, but
  46.  
  47.         run vbrowse editor "ged %s line %d"
  48.  
  49.     is wrong.
  50.  
  51.     If you double-click on the line containing error number etc. another
  52.     command will be invoked with the error number as argument. This command
  53.     should display a more detailed description of the error.
  54.  
  55.     This command can be specified by the 'error string' option, where
  56.     %d in string will be replaced by the error number.
  57.  
  58.     The program showerr is provided and should be ok for this.
  59.  
  60.     Also vbrowse accepts the keywords 'top', 'left', 'width' and 'height'
  61.     to specify the window position and size.
  62.  
  63.     A complete invocation of vbrowse may look like this:
  64.  
  65.     run vbrowse editor "rx my_arexx_script %d %s" error "showerr %d"
  66.                 top 400 left 0 width 600 height 200
  67.  
  68.     (Some '>nil:'s may be a good idea, too.)
  69.  
  70.  
  71. VSEND
  72.  
  73.     The program vsend is used to send some text (usually the error messages
  74.     of vbcc) to vbrowse. It simply reads from stdin and sends the text
  75.     without modifications to vbrowse, e.g.
  76.  
  77.         vsend <text_file_to_vbrowse
  78.  
  79.     If you have a pipe command installed you can e.g. type something like
  80.  
  81.         vc test.c | vsend
  82.  
  83.     to send the output of vc to vbrowse.
  84.  
  85.  
  86. TOVBR
  87.  
  88.     tovbr is a very small programm that simply executes its command line
  89.     and sends the result to vsend, i.e.
  90.  
  91.         tovbr my_command my_parameters
  92.  
  93.     is equivalent to
  94.  
  95.         my_command my_parameters | vsend
  96.  
  97.     So after e.g 'alias vc tovbr vc' you can use vc as before, but the
  98.     output will be sent to vbrowse.
  99.  
  100.  
  101. SHOWERR
  102.  
  103.     This is a very small program that takes an error number as argument
  104.     and displays the corresponding page in the VBCCMessages.guide using
  105.     amigaguide.library.
  106.     It can be used with vbrowse.
  107.  
  108.  
  109. Volker                                                  volker@vb.franken.de
  110.  
  111.